<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
  <meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />

  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
  <title>Utility functions &mdash; GSLab Make 2.0.0 documentation</title>
      <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
      <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
      <link rel="stylesheet" href="../_static/graphviz.css" type="text/css" />
  <!--[if lt IE 9]>
    <script src="../_static/js/html5shiv.min.js"></script>
  <![endif]-->
  
        <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
        <script src="../_static/jquery.js"></script>
        <script src="../_static/underscore.js"></script>
        <script src="../_static/_sphinx_javascript_frameworks_compat.js"></script>
        <script src="../_static/doctools.js"></script>
        <script src="../_static/sphinx_highlight.js"></script>
    <script src="../_static/js/theme.js"></script>
    <link rel="index" title="Index" href="../genindex.html" />
    <link rel="search" title="Search" href="../search.html" />
    <link rel="next" title="copy_output" href="api/make_utility/gslab_make.make_utility.copy_output.html" />
    <link rel="prev" title="run_stata" href="api/run_program/gslab_make.run_program.run_stata.html" /> 
</head>

<body class="wy-body-for-nav"> 
  <div class="wy-grid-for-nav">
    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
      <div class="wy-side-scroll">
        <div class="wy-side-nav-search" >

          
          
          <a href="../index.html" class="icon icon-home">
            GSLab Make
          </a>
<div role="search">
  <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
    <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
    <input type="hidden" name="check_keywords" value="yes" />
    <input type="hidden" name="area" value="default" />
  </form>
</div>
        </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
              <p class="caption" role="heading"><span class="caption-text">Documentation</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="specifying_paths.html">Specifying paths</a></li>
<li class="toctree-l1"><a class="reference internal" href="general_logging.html">General logging functions</a></li>
<li class="toctree-l1"><a class="reference internal" href="sourcing.html">Sourcing functions</a></li>
<li class="toctree-l1"><a class="reference internal" href="source_logging.html">Source logging functions</a></li>
<li class="toctree-l1"><a class="reference internal" href="program.html">Program functions</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Utility functions</a><ul>
<li class="toctree-l2"><a class="reference internal" href="api/make_utility/gslab_make.make_utility.copy_output.html">copy_output</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/make_utility/gslab_make.make_utility.update_executables.html">update_executables</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/make_utility/gslab_make.make_utility.update_external_paths.html">update_external_paths</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/make_utility/gslab_make.make_utility.update_internal_paths.html">update_internal_paths</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/make_utility/gslab_make.make_utility.update_paths.html">update_paths</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="repository.html">Repository functions</a></li>
<li class="toctree-l1"><a class="reference internal" href="directory.html">Directory functions</a></li>
<li class="toctree-l1"><a class="reference internal" href="filling.html">Filling functions</a></li>
</ul>

        </div>
      </div>
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
          <a href="../index.html">GSLab Make</a>
      </nav>

      <div class="wy-nav-content">
        <div class="rst-content">
          <div role="navigation" aria-label="Page navigation">
  <ul class="wy-breadcrumbs">
      <li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li>
      <li class="breadcrumb-item active">Utility functions</li>
      <li class="wy-breadcrumbs-aside">
            <a href="../_sources/pages/utility.rst.txt" rel="nofollow"> View page source</a>
      </li>
  </ul>
  <hr/>
</div>
          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
           <div itemprop="articleBody">
             
  <section id="utility-functions">
<h1>Utility functions<a class="headerlink" href="#utility-functions" title="Permalink to this heading"></a></h1>
<p>The <code class="xref py py-mod docutils literal notranslate"><span class="pre">gslab_make</span></code> library provides general utility functions for build scripts. Functions to update executable names/path mappings and copy outputs are included.</p>
<dl class="py function">
<dt class="sig sig-object py">
<span class="sig-name descname"><span class="pre">update_executables</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">paths</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">osname</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
<dd><p>Updates executable names with executables listed in file <code class="docutils literal notranslate"><span class="pre">config_user</span></code>.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Executable names are used by <a class="reference internal" href="program.html#program-functions"><span class="std std-ref">program functions</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>paths</strong> (<em>dict</em>) – Dictionary of paths. Dictionary should contain values for all keys listed below.</p></li>
<li><p><strong>osname</strong> (<em>str</em><em>, </em><em>optional</em>) – Name of OS. Defaults to <code class="docutils literal notranslate"><span class="pre">os.name</span></code>.</p></li>
</ul>
</dd>
<dt class="field-even">Path Keys<span class="colon">:</span></dt>
<dd class="field-even"><p><strong>config_user</strong> (<em>str</em>) – Path of user configuration file.</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>None</p>
</dd>
</dl>
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py">
<span class="sig-name descname"><span class="pre">update_external_paths</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">paths</span></span></em><span class="sig-paren">)</span></dt>
<dd><p>Updates dictionary <code class="docutils literal notranslate"><span class="pre">paths</span></code> with externals listed in file <code class="docutils literal notranslate"><span class="pre">config_user</span></code>.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>The <code class="docutils literal notranslate"><span class="pre">paths</span></code> argument for <a class="reference internal" href="sourcing.html#sourcing-functions"><span class="std std-ref">sourcing functions</span></a> is used not only to get
default paths for writing/logging, but also to
<a class="reference external" href="https://docs.python.org/3.4/library/string.html#format-string-syntax">string format</a>
sourcing instructions.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>paths</strong> (<em>dict</em>) – Dictionary of paths to update.
Dictionary should ex-ante contain values for all keys listed below.</p>
</dd>
<dt class="field-even">Path Keys<span class="colon">:</span></dt>
<dd class="field-even"><p><strong>config_user</strong> (<em>str</em>) – Path of user configuration file.</p>
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>paths</strong> – Dictionary of updated paths.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>dict</p>
</dd>
</dl>
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py">
<span class="sig-name descname"><span class="pre">update_internal_paths</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">paths</span></span></em><span class="sig-paren">)</span></dt>
<dd><p>Returns dictionary <code class="docutils literal notranslate"><span class="pre">paths</span></code> with directory locations listed in file <code class="docutils literal notranslate"><span class="pre">config</span></code>.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>paths</strong> (<em>dict</em>) – Dictionary of paths to update.
Dictionary should ex-ante contain values for all keys listed below.</p>
</dd>
<dt class="field-even">Path Keys<span class="colon">:</span></dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>root</strong> (<em>str</em>) – Path of project repo root</p></li>
<li><p><strong>config</strong> (<em>str</em>) – Path of user configuration file.</p></li>
</ul>
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>paths</strong> – Dictionary of paths.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>dict</p>
</dd>
</dl>
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py">
<span class="sig-name descname"><span class="pre">copy_output</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">file</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">copy_dir</span></span></em><span class="sig-paren">)</span></dt>
<dd><p>Copies output <code class="docutils literal notranslate"><span class="pre">file</span></code> to directory <code class="docutils literal notranslate"><span class="pre">copy_dir</span></code> with user prompt to confirm copy.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>file</strong> (<em>str</em>) – Path of file to copy.</p></li>
<li><p><strong>copy_dir</strong> (<em>str</em>) – Directory to copy file.</p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>None</p>
</dd>
</dl>
</dd></dl>

<div class="toctree-wrapper compound">
</div>
</section>


           </div>
          </div>
          <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
        <a href="api/run_program/gslab_make.run_program.run_stata.html" class="btn btn-neutral float-left" title="run_stata" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
        <a href="api/make_utility/gslab_make.make_utility.copy_output.html" class="btn btn-neutral float-right" title="copy_output" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
    </div>

  <hr/>

  <div role="contentinfo">
    <p>&#169; Copyright 2023, Matthew Gentzkow.</p>
  </div>

  Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
    <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
    provided by <a href="https://readthedocs.org">Read the Docs</a>.
   

</footer>
        </div>
      </div>
    </section>
  </div>
  <script>
      jQuery(function () {
          SphinxRtdTheme.Navigation.enable(true);
      });
  </script> 

</body>
</html>